<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Percepio Trace Recorder: Trace Object APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Percepio Trace Recorder<span id="projectnumber">&#160;v4.10.3</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('group__trace__object__apis.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Trace Object APIs<div class="ingroups"><a class="el" href="group__trace__recorder__apis.html">Trace Recorder APIs</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gaae4e70661707b924515088da8c45e6cf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#gaae4e70661707b924515088da8c45e6cf">xTraceObjectSetState</a>(xObjectHandle,  uxState)&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga3af120096177146ff9c25668ec8a53dc">xTraceObjectSetSpecificState</a>(xObjectHandle, 0, uxState)</td></tr>
<tr class="memdesc:gaae4e70661707b924515088da8c45e6cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace object state.  <br /></td></tr>
<tr class="separator:gaae4e70661707b924515088da8c45e6cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3af120096177146ff9c25668ec8a53dc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga3af120096177146ff9c25668ec8a53dc">xTraceObjectSetSpecificState</a>(xObjectHandle,  uiIndex,  uxState)&#160;&#160;&#160;xTraceEntrySetState((TraceEntryHandle_t)(xObjectHandle), uiIndex, uxState)</td></tr>
<tr class="memdesc:ga3af120096177146ff9c25668ec8a53dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace object specific state state.  <br /></td></tr>
<tr class="separator:ga3af120096177146ff9c25668ec8a53dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga220a4f45a6eea6d71779535ed38305b6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga220a4f45a6eea6d71779535ed38305b6">xTraceObjectSetOptions</a>(xObjectHandle,  uiOptions)&#160;&#160;&#160;xTraceEntrySetOptions((TraceEntryHandle_t)(xObjectHandle), uiOptions)</td></tr>
<tr class="memdesc:ga220a4f45a6eea6d71779535ed38305b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace object options.  <br /></td></tr>
<tr class="separator:ga220a4f45a6eea6d71779535ed38305b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa5422ce33454132194a70c055c6eb24c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#gaa5422ce33454132194a70c055c6eb24c">xTraceObjectSetStateWithoutHandle</a>(pvObject,  uxState)&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga0fdbe6a0c52767095939af3cfad7d3d9">xTraceObjectSetSpecificStateWithoutHandle</a>(pvObject, 0, uxState)</td></tr>
<tr class="memdesc:gaa5422ce33454132194a70c055c6eb24c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set trace object state without trace object handle.  <br /></td></tr>
<tr class="separator:gaa5422ce33454132194a70c055c6eb24c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gac5d5b90ac8b8422dbf99fdd2dab3b83e"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#gac5d5b90ac8b8422dbf99fdd2dab3b83e">xTraceObjectRegisterInternal</a> (uint32_t uiEventCode, void *const pvObject, const char *szName, TraceUnsignedBaseType_t uxStateCount, const TraceUnsignedBaseType_t uxStates[], TraceUnsignedBaseType_t uxOptions, TraceObjectHandle_t *pxObjectHandle)</td></tr>
<tr class="memdesc:gac5d5b90ac8b8422dbf99fdd2dab3b83e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers trace object.  <br /></td></tr>
<tr class="separator:gac5d5b90ac8b8422dbf99fdd2dab3b83e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga25d702dc46bb776c99c3ebd48f46c529"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga25d702dc46bb776c99c3ebd48f46c529">xTraceObjectRegister</a> (uint32_t uiEventCode, void *const pvObject, const char *szName, TraceUnsignedBaseType_t uxState, TraceObjectHandle_t *pxObjectHandle)</td></tr>
<tr class="memdesc:ga25d702dc46bb776c99c3ebd48f46c529"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers trace object.  <br /></td></tr>
<tr class="separator:ga25d702dc46bb776c99c3ebd48f46c529"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga605478977388e7ef2057eb4f5f35480a"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga605478977388e7ef2057eb4f5f35480a">xTraceObjectRegister2</a> (uint32_t uiEventCode, void *const pvObject, const char *szName, TraceUnsignedBaseType_t uxState1, TraceUnsignedBaseType_t uxState2, TraceObjectHandle_t *pxObjectHandle)</td></tr>
<tr class="memdesc:ga605478977388e7ef2057eb4f5f35480a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers trace object with two initial states.  <br /></td></tr>
<tr class="separator:ga605478977388e7ef2057eb4f5f35480a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga20b1def504b1c9b237c711b3aaa49e29"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga20b1def504b1c9b237c711b3aaa49e29">xTraceObjectUnregister</a> (TraceObjectHandle_t xObjectHandle, uint32_t uiEventCode, TraceUnsignedBaseType_t uxState)</td></tr>
<tr class="memdesc:ga20b1def504b1c9b237c711b3aaa49e29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters trace object.  <br /></td></tr>
<tr class="separator:ga20b1def504b1c9b237c711b3aaa49e29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga21b7803f059e9b3cf2d5528249ecb20d"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga21b7803f059e9b3cf2d5528249ecb20d">xTraceObjectSetName</a> (TraceObjectHandle_t xObjectHandle, const char *szName)</td></tr>
<tr class="memdesc:ga21b7803f059e9b3cf2d5528249ecb20d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace object name.  <br /></td></tr>
<tr class="separator:ga21b7803f059e9b3cf2d5528249ecb20d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd88161ed7cc325b7a343d9ec8fad34e"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#gacd88161ed7cc325b7a343d9ec8fad34e">xTraceObjectRegisterWithoutHandle</a> (uint32_t uiEventCode, void *pvObject, const char *szName, TraceUnsignedBaseType_t uxState)</td></tr>
<tr class="memdesc:gacd88161ed7cc325b7a343d9ec8fad34e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers trace object without trace object handle.  <br /></td></tr>
<tr class="separator:gacd88161ed7cc325b7a343d9ec8fad34e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga957e43ad6d5cc89c0ace01b1c1449996"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga957e43ad6d5cc89c0ace01b1c1449996">xTraceObjectRegisterWithoutHandle2</a> (uint32_t uiEventCode, void *pvObject, const char *szName, TraceUnsignedBaseType_t uxState1, TraceUnsignedBaseType_t uxState2)</td></tr>
<tr class="memdesc:ga957e43ad6d5cc89c0ace01b1c1449996"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers trace object with two initial states without trace object handle.  <br /></td></tr>
<tr class="separator:ga957e43ad6d5cc89c0ace01b1c1449996"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga304a75a1c8a64e02b0f8fe2355305555"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga304a75a1c8a64e02b0f8fe2355305555">xTraceObjectUnregisterWithoutHandle</a> (uint32_t uiEventCode, void *pvObject, TraceUnsignedBaseType_t uxState)</td></tr>
<tr class="memdesc:ga304a75a1c8a64e02b0f8fe2355305555"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters trace object without trace object handle.  <br /></td></tr>
<tr class="separator:ga304a75a1c8a64e02b0f8fe2355305555"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga085aa8d483021ba357d47cd9b213ba42"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga085aa8d483021ba357d47cd9b213ba42">xTraceObjectSetNameWithoutHandle</a> (void *pvObject, const char *szName)</td></tr>
<tr class="memdesc:ga085aa8d483021ba357d47cd9b213ba42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set trace object name without trace object handle.  <br /></td></tr>
<tr class="separator:ga085aa8d483021ba357d47cd9b213ba42"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0fdbe6a0c52767095939af3cfad7d3d9"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#ga0fdbe6a0c52767095939af3cfad7d3d9">xTraceObjectSetSpecificStateWithoutHandle</a> (void *pvObject, uint32_t uiIndex, TraceUnsignedBaseType_t uxState)</td></tr>
<tr class="memdesc:ga0fdbe6a0c52767095939af3cfad7d3d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace object specific state without trace object handle.  <br /></td></tr>
<tr class="separator:ga0fdbe6a0c52767095939af3cfad7d3d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab997b3f191923802347750aeecef8bda"><td class="memItemLeft" align="right" valign="top">traceResult&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__trace__object__apis.html#gab997b3f191923802347750aeecef8bda">xTraceObjectSetOptionsWithoutHandle</a> (void *pvObject, uint32_t uiOptions)</td></tr>
<tr class="memdesc:gab997b3f191923802347750aeecef8bda"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets trace object options without trace object handle.  <br /></td></tr>
<tr class="separator:gab997b3f191923802347750aeecef8bda"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga220a4f45a6eea6d71779535ed38305b6" name="ga220a4f45a6eea6d71779535ed38305b6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga220a4f45a6eea6d71779535ed38305b6">&#9670;&#160;</a></span>xTraceObjectSetOptions</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceObjectSetOptions</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xObjectHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uiOptions&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntrySetOptions((TraceEntryHandle_t)(xObjectHandle), uiOptions)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace object options. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xObjectHandle</td><td>Pointer to initialized trace object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiOptions</td><td>Options.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga3af120096177146ff9c25668ec8a53dc" name="ga3af120096177146ff9c25668ec8a53dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3af120096177146ff9c25668ec8a53dc">&#9670;&#160;</a></span>xTraceObjectSetSpecificState</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceObjectSetSpecificState</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xObjectHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uiIndex, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxState&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;xTraceEntrySetState((TraceEntryHandle_t)(xObjectHandle), uiIndex, uxState)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace object specific state state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xObjectHandle</td><td>Pointer to initialized trace object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiIndex</td><td>State Index. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState</td><td>State.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaae4e70661707b924515088da8c45e6cf" name="gaae4e70661707b924515088da8c45e6cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae4e70661707b924515088da8c45e6cf">&#9670;&#160;</a></span>xTraceObjectSetState</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceObjectSetState</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">xObjectHandle, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxState&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga3af120096177146ff9c25668ec8a53dc">xTraceObjectSetSpecificState</a>(xObjectHandle, 0, uxState)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace object state. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xObjectHandle</td><td>Pointer to initialized trace object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState</td><td>State.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaa5422ce33454132194a70c055c6eb24c" name="gaa5422ce33454132194a70c055c6eb24c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa5422ce33454132194a70c055c6eb24c">&#9670;&#160;</a></span>xTraceObjectSetStateWithoutHandle</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define xTraceObjectSetStateWithoutHandle</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">pvObject, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">uxState&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>&#160;&#160;&#160;<a class="el" href="group__trace__object__apis.html#ga0fdbe6a0c52767095939af3cfad7d3d9">xTraceObjectSetSpecificStateWithoutHandle</a>(pvObject, 0, uxState)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set trace object state without trace object handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState</td><td>State.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga25d702dc46bb776c99c3ebd48f46c529" name="ga25d702dc46bb776c99c3ebd48f46c529"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga25d702dc46bb776c99c3ebd48f46c529">&#9670;&#160;</a></span>xTraceObjectRegister()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectRegister </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiEventCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *const&#160;</td>
          <td class="paramname"><em>pvObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxState</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceObjectHandle_t *&#160;</td>
          <td class="paramname"><em>pxObjectHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers trace object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">uiEventCode</td><td>Event code. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState</td><td>State. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxObjectHandle</td><td>Pointer to uninitialized trace object.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga605478977388e7ef2057eb4f5f35480a" name="ga605478977388e7ef2057eb4f5f35480a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga605478977388e7ef2057eb4f5f35480a">&#9670;&#160;</a></span>xTraceObjectRegister2()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectRegister2 </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiEventCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *const&#160;</td>
          <td class="paramname"><em>pvObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxState1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxState2</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceObjectHandle_t *&#160;</td>
          <td class="paramname"><em>pxObjectHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers trace object with two initial states. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">uiEventCode</td><td>Event code. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState1</td><td>State 1. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState2</td><td>State 2. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxObjectHandle</td><td>Pointer to uninitialized trace object.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gac5d5b90ac8b8422dbf99fdd2dab3b83e" name="gac5d5b90ac8b8422dbf99fdd2dab3b83e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac5d5b90ac8b8422dbf99fdd2dab3b83e">&#9670;&#160;</a></span>xTraceObjectRegisterInternal()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectRegisterInternal </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiEventCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *const&#160;</td>
          <td class="paramname"><em>pvObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxStateCount</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxStates</em>[], </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxOptions</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceObjectHandle_t *&#160;</td>
          <td class="paramname"><em>pxObjectHandle</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers trace object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">uiEventCode</td><td>Event code. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxStateCount</td><td>State count. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxStates</td><td>States. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxOptions</td><td>Options. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">pxObjectHandle</td><td>Pointer to uninitialized trace object.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gacd88161ed7cc325b7a343d9ec8fad34e" name="gacd88161ed7cc325b7a343d9ec8fad34e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd88161ed7cc325b7a343d9ec8fad34e">&#9670;&#160;</a></span>xTraceObjectRegisterWithoutHandle()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectRegisterWithoutHandle </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiEventCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxState</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers trace object without trace object handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">uiEventCode</td><td>Event code. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState</td><td>State.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga957e43ad6d5cc89c0ace01b1c1449996" name="ga957e43ad6d5cc89c0ace01b1c1449996"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga957e43ad6d5cc89c0ace01b1c1449996">&#9670;&#160;</a></span>xTraceObjectRegisterWithoutHandle2()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectRegisterWithoutHandle2 </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiEventCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxState1</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxState2</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Registers trace object with two initial states without trace object handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">uiEventCode</td><td>Event code. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState1</td><td>State 1. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState2</td><td>State 2.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga21b7803f059e9b3cf2d5528249ecb20d" name="ga21b7803f059e9b3cf2d5528249ecb20d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga21b7803f059e9b3cf2d5528249ecb20d">&#9670;&#160;</a></span>xTraceObjectSetName()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectSetName </td>
          <td>(</td>
          <td class="paramtype">TraceObjectHandle_t&#160;</td>
          <td class="paramname"><em>xObjectHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace object name. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xObjectHandle</td><td>Pointer to initialized trace object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga085aa8d483021ba357d47cd9b213ba42" name="ga085aa8d483021ba357d47cd9b213ba42"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga085aa8d483021ba357d47cd9b213ba42">&#9670;&#160;</a></span>xTraceObjectSetNameWithoutHandle()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectSetNameWithoutHandle </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>szName</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set trace object name without trace object handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">szName</td><td>Name.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gab997b3f191923802347750aeecef8bda" name="gab997b3f191923802347750aeecef8bda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab997b3f191923802347750aeecef8bda">&#9670;&#160;</a></span>xTraceObjectSetOptionsWithoutHandle()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectSetOptionsWithoutHandle </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiOptions</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace object options without trace object handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiOptions</td><td>Options.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga0fdbe6a0c52767095939af3cfad7d3d9" name="ga0fdbe6a0c52767095939af3cfad7d3d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0fdbe6a0c52767095939af3cfad7d3d9">&#9670;&#160;</a></span>xTraceObjectSetSpecificStateWithoutHandle()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectSetSpecificStateWithoutHandle </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxState</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets trace object specific state without trace object handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiIndex</td><td>State index. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState</td><td>State.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga20b1def504b1c9b237c711b3aaa49e29" name="ga20b1def504b1c9b237c711b3aaa49e29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga20b1def504b1c9b237c711b3aaa49e29">&#9670;&#160;</a></span>xTraceObjectUnregister()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectUnregister </td>
          <td>(</td>
          <td class="paramtype">TraceObjectHandle_t&#160;</td>
          <td class="paramname"><em>xObjectHandle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiEventCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxState</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unregisters trace object. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">xObjectHandle</td><td>Pointer to initialized trace object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uiEventCode</td><td>Event code. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState</td><td>State.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga304a75a1c8a64e02b0f8fe2355305555" name="ga304a75a1c8a64e02b0f8fe2355305555"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga304a75a1c8a64e02b0f8fe2355305555">&#9670;&#160;</a></span>xTraceObjectUnregisterWithoutHandle()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">traceResult xTraceObjectUnregisterWithoutHandle </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>uiEventCode</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pvObject</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TraceUnsignedBaseType_t&#160;</td>
          <td class="paramname"><em>uxState</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unregisters trace object without trace object handle. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">uiEventCode</td><td>Event code. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">pvObject</td><td>Object. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">uxState</td><td>State.</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">TRC_FAIL</td><td>Failure </td></tr>
    <tr><td class="paramname">TRC_SUCCESS</td><td>Success </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
  </ul>
</div>
</body>
</html>
